Repository navigation
Use a neutral example standard in docs and comments - #6
Merged
Merged
Conversation
Replace the VITA 49.2 worked example with a generic EXAMPLE-STD-1.0 placeholder across the documentation, comments and docstrings, so the public repository does not name the specific commercial standard in its illustrative examples. The functional pieces that genuinely name it are left untouched -- the ANSI-VITA-49.2 role taxonomy in standard_profiles.py and the VITA entry in the standards-body list in normative_claims.py -- and so is the test suite, which still binds the example standard by its real id.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replace the VITA 49.2 worked example with a generic
EXAMPLE-STD-1.0placeholder across documentation, comments and docstrings (12 files, 47 replacements), so the public repository does not name the specific commercial standard in its illustrative examples.Kept on purpose
ANSI-VITA-49.2role taxonomy instandard_profiles.pyand theVITAentry in the standards-body list innormative_claims.py— removing these drops real capability.client/tests/), which still binds the example standard by its real id.So the docs and comments no longer name the standard; the taxonomy, the body list and the tests still do. Taking it out of the tests as well is a larger, separate change.
Verified:
py_compileon all touched modules; the doc examples read coherently. The full test suite should be run on the configured host.